home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xi / XGrabDeviceButton.z / XGrabDeviceButton
Encoding:
Text File  |  1998-10-30  |  13.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XGrabDeviceButton, XUngrabDeviceButton - grab/ungrab
  10.           extension input device buttons
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((_d_i_s_p_l_a_y,,,, _d_e_v_i_c_e,,,, _b_u_t_t_o_n,,,, _m_o_d_i_f_i_e_r_s,,,, _m_o_d_i_f_i_e_r__d_e_v_i_c_e,,,, _g_r_a_b__w_i_n_d_o_w,,,,
  14.           _o_w_n_e_r__e_v_e_n_t_s,,,, _e_v_e_n_t__c_o_u_n_t,,,, _e_v_e_n_t__l_i_s_t,,,, _t_h_i_s__d_e_v_i_c_e__m_o_d_e,,,, _o_t_h_e_r__d_e_v_i_c_e_s__m_o_d_e))))
  15.                 DDDDiiiissssppppllllaaaayyyy ****_d_i_s_p_l_a_y;;;;
  16.                 XXXXDDDDeeeevvvviiiicccceeee ****_d_e_v_i_c_e;;;;
  17.                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt _b_u_t_t_o_n;;;;
  18.                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt _m_o_d_i_f_i_e_r_s;;;;
  19.                 XXXXDDDDeeeevvvviiiicccceeee ****_m_o_d_i_f_i_e_r__d_e_v_i_c_e;;;;
  20.                 WWWWiiiinnnnddddoooowwww _g_r_a_b__w_i_n_d_o_w;;;;
  21.                 BBBBoooooooollll _o_w_n_e_r__e_v_e_n_t_s;;;;
  22.                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt _e_v_e_n_t__c_o_u_n_t;;;;
  23.                 XXXXEEEEvvvveeeennnnttttCCCCllllaaaassssssss ****_e_v_e_n_t__l_i_s_t;;;;
  24.                 iiiinnnntttt _t_h_i_s__d_e_v_i_c_e__m_o_d_e,,,, _o_t_h_e_r__d_e_v_i_c_e_s__m_o_d_e;;;;
  25.  
  26.           XXXXUUUUnnnnggggrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((_d_i_s_p_l_a_y,,,, _d_e_v_i_c_e,,,, _b_u_t_t_o_n,,,, _m_o_d_i_f_i_e_r_s,,,, _m_o_d_i_f_i_e_r__d_e_v_i_c_e,,,, _g_r_a_b__w_i_n_d_o_w))))
  27.                 DDDDiiiissssppppllllaaaayyyy ****_d_i_s_p_l_a_y;;;;
  28.                 XXXXDDDDeeeevvvviiiicccceeee ****_d_e_v_i_c_e;;;;
  29.                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt _b_u_t_t_o_n;;;;
  30.                 uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt _m_o_d_i_f_i_e_r_s;;;;
  31.                 XXXXDDDDeeeevvvviiiicccceeee ****_m_o_d_i_f_i_e_r__d_e_v_i_c_e;;;;
  32.                 WWWWiiiinnnnddddoooowwww _g_r_a_b__w_i_n_d_o_w;;;;
  33.  
  34.  
  35.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  36.           _d_i_s_p_l_a_y     Specifies the connection to the X server.
  37.  
  38.           _d_e_v_i_c_e      Specifies the device that is to be grabbed or
  39.                       released
  40.  
  41.           _b_u_t_t_o_n      Specifies the device button that is to be
  42.                       grabbed or released or _A_n_y_B_u_t_t_o_n.
  43.  
  44.           _m_o_d_i_f_i_e_r_s   Specifies the set of keymasks or _A_n_y_M_o_d_i_f_i_e_r.
  45.                       The mask is the bitwise inclusive OR of the
  46.                       valid keymask bits.  Valid bits are: Shiftmask,
  47.                       LockMask, ControlMask, Mod1Mask, Mod2Mask,
  48.                       Mod3Mask, Mod4Mask, Mod5Mask.
  49.  
  50.           _m_o_d_i_f_i_e_r__d_e_v_i_c_e
  51.                       specifies the device whose modifiers are to be
  52.                       used.  If the modifier_device specified is NULL,
  53.                       the X keyboard will be used as the
  54.                       modifier_device.
  55.  
  56.           _g_r_a_b__w_i_n_d_o_w Specifies the grab window.
  57.  
  58.           _o_w_n_e_r__e_v_e_n_t_s
  59.                       Specifies a Boolean value that indicates whether
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.                       the device events are to be reported as usual or
  75.                       reported with respect to the grab window if
  76.                       selected by the event list.
  77.  
  78.           _e_v_e_n_t__c_o_u_n_t Specifies the number of event classes in the
  79.                       event list.
  80.  
  81.           _e_v_e_n_t__l_i_s_t  Specifies which events are reported to the
  82.                       client.
  83.  
  84.           _t_h_i_s__d_e_v_i_c_e__m_o_d_e
  85.                       Specifies further processing of events from this
  86.                       device.  You can pass _G_r_a_b_M_o_d_e_S_y_n_c or
  87.                       _G_r_a_b_M_o_d_e_A_s_y_n_c.
  88.  
  89.           _o_t_h_e_r__d_e_v_i_c_e_s__m_o_d_e
  90.                       Specifies further processing of events from all
  91.                       other devices.  You can pass _G_r_a_b_M_o_d_e_S_y_n_c or
  92.                       _G_r_a_b_M_o_d_e_A_s_y_n_c.
  93.  
  94.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  95.           The _X_G_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n request establishes a passive grab.
  96.           In the future, the device is actively grabbed (as for
  97.           _X_G_r_a_b_D_e_v_i_c_e, the last-grab time is set to the time at which
  98.           the button was pressed (as transmitted in the
  99.           _D_e_v_i_c_e_B_u_t_t_o_n_P_r_e_s_s event), and the _D_e_v_i_c_e_B_u_t_t_o_n_P_r_e_s_s event is
  100.           reported if all of the following conditions are true:
  101.  
  102.           +o    The device is not grabbed, and the specified button is
  103.                logically pressed when the specified modifier keys are
  104.                logically down on the specified modifier device and no
  105.                other buttons or modifier keys are logically down.
  106.  
  107.           +o    Either the grab window is an ancestor of (or is) the
  108.                focus window, OR the grab window is a descendent of the
  109.                focus window and contains the device.
  110.  
  111.           +o    A passive grab on the same button/modifier combination
  112.                does not exist on any ancestor of grab_window.
  113.  
  114.           The interpretation of the remaining arguments is as for
  115.           _X_G_r_a_b_D_e_v_i_c_e.  The active grab is terminated automatically
  116.           when the logical state of the device has all buttons
  117.           released (independent of the logical state of the modifier
  118.           keys).
  119.  
  120.           Note that the logical state of a device (as seen by client
  121.           applications) may lag the physical state if device event
  122.           processing is frozen.
  123.  
  124.           This request overrides all previous grabs by the same client
  125.           on the same button/modifier combinations on the same window.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           A modifiers of _A_n_y_M_o_d_i_f_i_e_r is equivalent to issuing the grab
  141.           request for all possible modifier combinations (including
  142.           the combination of no modifiers). It is not required that
  143.           all modifiers specified have currently assigned KeyCodes.  A
  144.           button of _A_n_y_B_u_t_t_o_n is equivalent to issuing the request for
  145.           all possible buttons.  Otherwise, it is not required that
  146.           the specified button currently be assigned to a physical
  147.           button.
  148.  
  149.           A modifier_device of NULL indicates that the X keyboard is
  150.           to be used as the modifier_device.
  151.  
  152.           If some other client has already issued a _X_G_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n
  153.           with the same button/modifier combination on the same
  154.           window, a _B_a_d_A_c_c_e_s_s error results.  When using _A_n_y_M_o_d_i_f_i_e_r
  155.           or _A_n_y_B_u_t_t_o_n , the request fails completely, and a _B_a_d_A_c_c_e_s_s
  156.           error results (no grabs are established) if there is a
  157.           conflicting grab for any combination.  _X_G_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n has
  158.           no effect on an active grab.
  159.  
  160.           _X_G_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n can generate _B_a_d_C_l_a_s_s, _B_a_d_D_e_v_i_c_e,
  161.           _B_a_d_M_a_t_c_h, _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
  162.  
  163.           The _X_U_n_g_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n request releases the passive grab
  164.           for a button/modifier combination on the specified window if
  165.           it was grabbed by this client.  A modifier of _A_n_y_M_o_d_i_f_i_e_r is
  166.           equivalent to issuing the ungrab request for all possible
  167.           modifier combinations, including the combination of no
  168.           modifiers.  A button of _A_n_y_B_u_t_t_o_n is equivalent to issuing
  169.           the request for all possible buttons.  _X_U_n_g_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n
  170.           has no effect on an active grab.
  171.  
  172.           A modifier_device of NULL indicates that the X keyboard
  173.           should be used as the modifier_device.
  174.  
  175.           _X_U_n_g_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n can generate _B_a_d_D_e_v_i_c_e, _B_a_d_M_a_t_c_h,
  176.           _B_a_d_V_a_l_u_e and _B_a_d_W_i_n_d_o_w errors.
  177.  
  178.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  179.           _B_a_d_D_e_v_i_c_e   An invalid device was specified.  The specified
  180.                       device does not exist or has not been opened by
  181.                       this client via _X_O_p_e_n_I_n_p_u_t_D_e_v_i_c_e.  This error
  182.                       may also occur if the specified device is the X
  183.                       keyboard or X pointer device.
  184.  
  185.           _B_a_d_M_a_t_c_h    This error may occur if an _X_G_r_a_b_D_e_v_i_c_e_B_u_t_t_o_n
  186.                       request was made specifying a device that has no
  187.                       buttons, or specifying a modifier device that
  188.                       has no keys.
  189.  
  190.           _B_a_d_V_a_l_u_e    Some numeric value falls outside the range of
  191.                       values accepted by the request.  Unless a
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXGGGGrrrraaaabbbbDDDDeeeevvvviiiicccceeeeBBBBuuuuttttttttoooonnnn((((3333XXXX11111111))))
  203.  
  204.  
  205.  
  206.                       specific range is specified for an argument, the
  207.                       full range defined by the argument's type is
  208.                       accepted.  Any argument defined as a set of
  209.                       alternatives can generate this error.
  210.  
  211.           _B_a_d_W_i_n_d_o_w   A value for a Window argument does not name a
  212.                       defined Window.
  213.  
  214.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  215.           XAllowDeviceEvents(3X),
  216.           XGrabDevice(3X),
  217.           XGrabDeviceKey(3X),
  218.           _P_r_o_g_r_a_m_m_i_n_g _W_i_t_h _X_l_i_b
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.